Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(integrations): feature for server side container url support ga4 #1814

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

utsabc
Copy link
Member

@utsabc utsabc commented Jul 31, 2024

PR Description

Adding support for server side container support for Ga4

Linear task (optional)

INT-2454

Cross Browser Tests

Please confirm you have tested for the following browsers:

  • Chrome
  • Firefox
  • IE11

Sanity Suite

  • All sanity suite test cases pass locally

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

Summary by CodeRabbit

  • New Features

    • Enhanced Google Analytics integration with the addition of a configurable serverContainerUrl property, improving tracking flexibility.
  • Bug Fixes

    • Improved validation checks for the serverContainerUrl to ensure proper configuration.
  • Style

    • Minor formatting adjustments made for better code readability.

@utsabc utsabc requested a review from a team July 31, 2024 11:38
Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Walkthrough

Walkthrough

The recent updates to the GA4 integration enhance its configurability by introducing a serverContainerUrl property in the class constructor. This new property, which defaults to null, allows users to specify a server container URL for Google Analytics tracking. Additionally, a utility function now checks the validity of this property, ensuring that it is included in the parameter object when defined. Minor formatting improvements were also made for better code readability.

Changes

Files Change Summary
.../GA4/browser.js Added serverContainerUrl property to GA4 class constructor. Introduced isDefinedAndNotNull utility to validate serverContainerUrl. Modified logic to include server_container_url in tracking parameters if defined. Minor formatting adjustments for readability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GA4
    participant Analytics

    User->>GA4: Initialize with serverContainerUrl
    GA4->>GA4: Check if serverContainerUrl is defined
    alt Defined
        GA4->>Analytics: Send tracking data with server_container_url
    else Not Defined
        GA4->>Analytics: Send tracking data without server_container_url
    end
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@utsabc utsabc changed the base branch from develop to main July 31, 2024 11:38
@utsabc utsabc self-assigned this Jul 31, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1a8fee8 and cfbea6c.

Files selected for processing (1)
  • packages/analytics-js-integrations/src/integrations/GA4/browser.js (5 hunks)
Additional comments not posted (3)
packages/analytics-js-integrations/src/integrations/GA4/browser.js (3)

47-47: New property serverContainerUrl added to the constructor.

The serverContainerUrl property allows specifying a server container URL for Google Analytics tracking. Ensure this property is correctly utilized in the class methods.


66-68: Include serverContainerUrl in gtagParameterObject if defined.

The serverContainerUrl is now included in the gtagParameterObject when it is defined and not null. This enhances the configurability of the GA4 integration.


66-68: LGTM! The inclusion of serverContainerUrl is correct.

The changes to include serverContainerUrl in the gtagParameterObject are correct and improve the flexibility of the configuration.

Copy link

codecov bot commented Jul 31, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 56.67%. Comparing base (2d65fe1) to head (cfbea6c).

Files Patch % Lines
...cs-js-integrations/src/integrations/GA4/browser.js 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1814      +/-   ##
==========================================
+ Coverage   56.54%   56.67%   +0.13%     
==========================================
  Files         473      473              
  Lines       16114    16111       -3     
  Branches     3229     3216      -13     
==========================================
+ Hits         9111     9131      +20     
- Misses       5726     5764      +38     
+ Partials     1277     1216      -61     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

sonarcloud bot commented Jul 31, 2024

Copy link

size-limit report 📦

Name Size (Base) Size (Current) Size Limit Status
Cookies Utils - Legacy - NPM (ESM) 1.54 KB 1.54 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (CJS) 1.75 KB 1.75 KB (0%) 2 KB
Cookies Utils - Legacy - NPM (UMD) 1.53 KB 1.53 KB (0%) 2 KB
Cookies Utils - Modern - NPM (ESM) 1.17 KB 1.17 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (CJS) 1.4 KB 1.4 KB (0%) 1.5 KB
Cookies Utils - Modern - NPM (UMD) 1.16 KB 1.16 KB (0%) 1.5 KB
Plugins Module Federation Mapping - Legacy - CDN 332 B 332 B (0%) 512 B
Plugins - Legacy - CDN 15.88 KB 15.88 KB (0%) 16 KB
Plugins Module Federation Mapping - Modern - CDN 331 B 331 B (0%) 512 B
Plugins - Modern - CDN 7.19 KB 7.19 KB (0%) 7.5 KB
Common - No bundling 15.89 KB 15.85 KB (-0.25% ▼) 16.5 KB
Service Worker - Legacy - NPM (ESM) 29.46 KB 29.46 KB (0%) 30 KB
Service Worker - Legacy - NPM (CJS) 29.61 KB 29.61 KB (0%) 30 KB
Service Worker - Legacy - NPM (UMD) 29.44 KB 29.44 KB (0%) 30 KB
Service Worker - Modern - NPM (ESM) 24.59 KB 24.59 KB (0%) 25 KB
Service Worker - Modern - NPM (CJS) 24.88 KB 24.88 KB (0%) 25 KB
Service Worker - Modern - NPM (UMD) 24.67 KB 24.67 KB (0%) 25 KB
Core (v1.1) - NPM (ESM) 29.81 KB 29.81 KB (0%) 32 KB
Core (v1.1) - NPM (CJS) 29.97 KB 29.97 KB (0%) 32 KB
Core (v1.1) - NPM (UMD) 29.89 KB 29.89 KB (0%) 32 KB
Core (Content Script - v1.1) - NPM (ESM) 29.33 KB 29.33 KB (0%) 30 KB
Core (Content Script - v1.1) - NPM (CJS) 29.54 KB 29.54 KB (0%) 30 KB
Core (Content Script - v1.1) - NPM (UMD) 29.42 KB 29.42 KB (0%) 30 KB
Core - Legacy - CDN 47.4 KB 47.4 KB (0%) 48 KB
Core - Modern - CDN 24.09 KB 24.09 KB (0%) 24.5 KB
Load Snippet 724 B 724 B (0%) 1 KB
Core - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB
Core - Legacy - NPM (CJS) 47.5 KB 47.5 KB (0%) 48 KB
Core - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB
Core - Modern - NPM (ESM) 23.83 KB 23.83 KB (0%) 24.5 KB
Core - Modern - NPM (CJS) 24.06 KB 24.06 KB (0%) 24.5 KB
Core - Modern - NPM (UMD) 23.86 KB 23.86 KB (0%) 24.5 KB
Core (Bundled) - Legacy - NPM (ESM) 47.29 KB 47.29 KB (0%) 47.5 KB
Core (Bundled) - Legacy - NPM (CJS) 47.53 KB 47.53 KB (0%) 48 KB
Core (Bundled) - Legacy - NPM (UMD) 47.28 KB 47.28 KB (0%) 47.5 KB
Core (Bundled) - Modern - NPM (ESM) 38.54 KB 38.54 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (CJS) 38.8 KB 38.8 KB (0%) 39 KB
Core (Bundled) - Modern - NPM (UMD) 38.53 KB 38.53 KB (0%) 39 KB
Core (Content Script) - Legacy - NPM (ESM) 46.75 KB 46.75 KB (0%) 47 KB
Core (Content Script) - Legacy - NPM (CJS) 47.01 KB 47.01 KB (0%) 47.5 KB
Core (Content Script) - Legacy - NPM (UMD) 46.77 KB 46.77 KB (0%) 47 KB
Core (Content Script) - Modern - NPM (ESM) 38.01 KB 38.01 KB (0%) 38.5 KB
Core (Content Script) - Modern - NPM (CJS) 38.3 KB 38.3 KB (0%) 38.5 KB
Core (Content Script) - Modern - NPM (UMD) 37.99 KB 37.99 KB (0%) 38.5 KB
All Integrations - Legacy - CDN 93.68 KB 93.65 KB (-0.03% ▼) 95.3 KB
All Integrations - Modern - CDN 88.71 KB 88.81 KB (+0.11% ▲) 91 KB

@utsabc utsabc merged commit 2e54ec0 into hotfix/1.8.24 Aug 1, 2024
12 checks passed
@utsabc utsabc deleted the feat.ga4-enhancements branch August 1, 2024 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants